<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FreeRTOS Addons: cpp_freertos::Timer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">FreeRTOS Addons
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacecpp__freertos.html">cpp_freertos</a></li><li class="navelem"><a class="el" href="classcpp__freertos_1_1_timer.html">Timer</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classcpp__freertos_1_1_timer-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">cpp_freertos::Timer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="timer_8hpp_source.html">timer.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab9df38de944064725d42f9e8572bcf6a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_timer.html#ab9df38de944064725d42f9e8572bcf6a">Timer</a> (const char *const TimerName, TickType_t PeriodInTicks, bool Periodic=true)</td></tr>
<tr class="separator:ab9df38de944064725d42f9e8572bcf6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b1e228f95973e9088990a53d0ee5a1a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_timer.html#a6b1e228f95973e9088990a53d0ee5a1a">Timer</a> (TickType_t PeriodInTicks, bool Periodic=true)</td></tr>
<tr class="separator:a6b1e228f95973e9088990a53d0ee5a1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14fa469c4c295c5fa6e66a4ad1092146"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_timer.html#a14fa469c4c295c5fa6e66a4ad1092146">~Timer</a> ()</td></tr>
<tr class="separator:a14fa469c4c295c5fa6e66a4ad1092146"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6ed24372a8bbf6f94c7b839960243d2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_timer.html#aa6ed24372a8bbf6f94c7b839960243d2">IsActive</a> ()</td></tr>
<tr class="separator:aa6ed24372a8bbf6f94c7b839960243d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96d82602e1649be3d73866037f538359"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_timer.html#a96d82602e1649be3d73866037f538359">Reset</a> (TickType_t CmdTimeout=portMAX_DELAY)</td></tr>
<tr class="separator:a96d82602e1649be3d73866037f538359"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe2ba000ef220abfb0ad36e9d61094f2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_timer.html#abe2ba000ef220abfb0ad36e9d61094f2">ResetFromISR</a> (BaseType_t *pxHigherPriorityTaskWoken)</td></tr>
<tr class="separator:abe2ba000ef220abfb0ad36e9d61094f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa86f6d14b67157711e6e3001a8d79e65"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_timer.html#aa86f6d14b67157711e6e3001a8d79e65">SetPeriod</a> (TickType_t NewPeriod, TickType_t CmdTimeout=portMAX_DELAY)</td></tr>
<tr class="separator:aa86f6d14b67157711e6e3001a8d79e65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f072ddbcaba51714bdebe9d107e747f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_timer.html#a0f072ddbcaba51714bdebe9d107e747f">SetPeriodFromISR</a> (TickType_t NewPeriod, BaseType_t *pxHigherPriorityTaskWoken)</td></tr>
<tr class="separator:a0f072ddbcaba51714bdebe9d107e747f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a171c77988a6d4c2d8d32f86344514359"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_timer.html#a171c77988a6d4c2d8d32f86344514359">Start</a> (TickType_t CmdTimeout=portMAX_DELAY)</td></tr>
<tr class="separator:a171c77988a6d4c2d8d32f86344514359"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae512d19700e4197dfb6b6e7c59fa6143"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_timer.html#ae512d19700e4197dfb6b6e7c59fa6143">StartFromISR</a> (BaseType_t *pxHigherPriorityTaskWoken)</td></tr>
<tr class="separator:ae512d19700e4197dfb6b6e7c59fa6143"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15873ed66f31b28e7c7af88ca0c9d2d5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_timer.html#a15873ed66f31b28e7c7af88ca0c9d2d5">Stop</a> (TickType_t CmdTimeout=portMAX_DELAY)</td></tr>
<tr class="separator:a15873ed66f31b28e7c7af88ca0c9d2d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a403285c6e10f401cd3d9fb43843092cb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_timer.html#a403285c6e10f401cd3d9fb43843092cb">StopFromISR</a> (BaseType_t *pxHigherPriorityTaskWoken)</td></tr>
<tr class="separator:a403285c6e10f401cd3d9fb43843092cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:af6d4167af4fd308d78e56ca6d713b8c4"><td class="memItemLeft" align="right" valign="top">static TaskHandle_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_timer.html#af6d4167af4fd308d78e56ca6d713b8c4">GetTimerDaemonHandle</a> ()</td></tr>
<tr class="separator:af6d4167af4fd308d78e56ca6d713b8c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:abfb9dfc3970efe4c1d5e344df787ad80"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_timer.html#abfb9dfc3970efe4c1d5e344df787ad80">Run</a> ()=0</td></tr>
<tr class="separator:abfb9dfc3970efe4c1d5e344df787ad80"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Wrapper class around FreeRTOS's implementation of a timer.</p>
<p >This is an abstract base class. To use this, you need to subclass it. All of your timers should be derived from the <a class="el" href="classcpp__freertos_1_1_timer.html">Timer</a> class. Then implement the virtual Run function. This is a similar design to Java threading. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ab9df38de944064725d42f9e8572bcf6a" name="ab9df38de944064725d42f9e8572bcf6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9df38de944064725d42f9e8572bcf6a">&#9670;&#160;</a></span>Timer() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Timer::Timer </td>
          <td>(</td>
          <td class="paramtype">const char *const&#160;</td>
          <td class="paramname"><em>TimerName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TickType_t&#160;</td>
          <td class="paramname"><em>PeriodInTicks</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>Periodic</em> = <code>true</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p >Construct a named timer. Timers are not active after they are created, you need to activate them via Start, Reset, etc.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname"><a class="el" href="classcpp__freertos_1_1_timer_create_exception.html">TimerCreateException</a></td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">TimerName</td><td>Name of the timer for debug. </td></tr>
    <tr><td class="paramname">PeriodInTicks</td><td>When does the timer expire and run your <a class="el" href="classcpp__freertos_1_1_timer.html#abfb9dfc3970efe4c1d5e344df787ad80">Run()</a> method. </td></tr>
    <tr><td class="paramname">Periodic</td><td>true if the timer expires every PeriodInTicks. false if this is a one shot timer. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a6b1e228f95973e9088990a53d0ee5a1a" name="a6b1e228f95973e9088990a53d0ee5a1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b1e228f95973e9088990a53d0ee5a1a">&#9670;&#160;</a></span>Timer() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Timer::Timer </td>
          <td>(</td>
          <td class="paramtype">TickType_t&#160;</td>
          <td class="paramname"><em>PeriodInTicks</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>Periodic</em> = <code>true</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p >Construct an unnamed timer. Timers are not active after they are created, you need to activate them via Start, Reset, etc.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname"><a class="el" href="classcpp__freertos_1_1_timer_create_exception.html">TimerCreateException</a></td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">PeriodInTicks</td><td>When does the timer expire and run your <a class="el" href="classcpp__freertos_1_1_timer.html#abfb9dfc3970efe4c1d5e344df787ad80">Run()</a> method. </td></tr>
    <tr><td class="paramname">Periodic</td><td>true if the timer expires every PeriodInTicks. false if this is a one shot timer. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a14fa469c4c295c5fa6e66a4ad1092146" name="a14fa469c4c295c5fa6e66a4ad1092146"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14fa469c4c295c5fa6e66a4ad1092146">&#9670;&#160;</a></span>~Timer()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Timer::~Timer </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p >Destructor </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af6d4167af4fd308d78e56ca6d713b8c4" name="af6d4167af4fd308d78e56ca6d713b8c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6d4167af4fd308d78e56ca6d713b8c4">&#9670;&#160;</a></span>GetTimerDaemonHandle()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">TaskHandle_t Timer::GetTimerDaemonHandle </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p >If you need it, obtain the task handle of the FreeRTOS task that is running the timers.</p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classcpp__freertos_1_1_task.html" title="A Thread which has the Run method implemented as loop which is executing the function that is passed ...">Task</a> handle of the FreeRTOS timer task. </dd></dl>

</div>
</div>
<a id="aa6ed24372a8bbf6f94c7b839960243d2" name="aa6ed24372a8bbf6f94c7b839960243d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6ed24372a8bbf6f94c7b839960243d2">&#9670;&#160;</a></span>IsActive()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Timer::IsActive </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p >Is the timer currently active?</p>
<dl class="section return"><dt>Returns</dt><dd>true if the timer is active, false otherwise. </dd></dl>

</div>
</div>
<a id="a96d82602e1649be3d73866037f538359" name="a96d82602e1649be3d73866037f538359"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96d82602e1649be3d73866037f538359">&#9670;&#160;</a></span>Reset()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Timer::Reset </td>
          <td>(</td>
          <td class="paramtype">TickType_t&#160;</td>
          <td class="paramname"><em>CmdTimeout</em> = <code>portMAX_DELAY</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p >Reset a timer. This changes the state to active.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">CmdTimeout</td><td>How long to wait to send this command to the timer code. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if this command will be sent to the timer code, false if it will not (i.e. timeout). </dd></dl>

</div>
</div>
<a id="abe2ba000ef220abfb0ad36e9d61094f2" name="abe2ba000ef220abfb0ad36e9d61094f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe2ba000ef220abfb0ad36e9d61094f2">&#9670;&#160;</a></span>ResetFromISR()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Timer::ResetFromISR </td>
          <td>(</td>
          <td class="paramtype">BaseType_t *&#160;</td>
          <td class="paramname"><em>pxHigherPriorityTaskWoken</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p >Reset a timer from ISR context. This changes the state to active.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pxHigherPriorityTaskWoken</td><td>Did this operation result in a rescheduling event. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if this command will be sent to the timer code, false if it will not (i.e. timeout). </dd></dl>

</div>
</div>
<a id="abfb9dfc3970efe4c1d5e344df787ad80" name="abfb9dfc3970efe4c1d5e344df787ad80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abfb9dfc3970efe4c1d5e344df787ad80">&#9670;&#160;</a></span>Run()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void cpp_freertos::Timer::Run </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p >Implementation of your actual timer code. You must override this function. </p>

</div>
</div>
<a id="aa86f6d14b67157711e6e3001a8d79e65" name="aa86f6d14b67157711e6e3001a8d79e65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa86f6d14b67157711e6e3001a8d79e65">&#9670;&#160;</a></span>SetPeriod()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Timer::SetPeriod </td>
          <td>(</td>
          <td class="paramtype">TickType_t&#160;</td>
          <td class="paramname"><em>NewPeriod</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TickType_t&#160;</td>
          <td class="paramname"><em>CmdTimeout</em> = <code>portMAX_DELAY</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p >Change a timer's period.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">NewPeriod</td><td>The period in ticks. </td></tr>
    <tr><td class="paramname">CmdTimeout</td><td>How long to wait to send this command to the timer code. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if this command will be sent to the timer code, false if it will not (i.e. timeout). </dd></dl>

</div>
</div>
<a id="a0f072ddbcaba51714bdebe9d107e747f" name="a0f072ddbcaba51714bdebe9d107e747f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f072ddbcaba51714bdebe9d107e747f">&#9670;&#160;</a></span>SetPeriodFromISR()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Timer::SetPeriodFromISR </td>
          <td>(</td>
          <td class="paramtype">TickType_t&#160;</td>
          <td class="paramname"><em>NewPeriod</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">BaseType_t *&#160;</td>
          <td class="paramname"><em>pxHigherPriorityTaskWoken</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p >Change a timer's period from ISR context.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">NewPeriod</td><td>The period in ticks. </td></tr>
    <tr><td class="paramname">pxHigherPriorityTaskWoken</td><td>Did this operation result in a rescheduling event. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if this command will be sent to the timer code, false if it will not (i.e. timeout). </dd></dl>

</div>
</div>
<a id="a171c77988a6d4c2d8d32f86344514359" name="a171c77988a6d4c2d8d32f86344514359"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a171c77988a6d4c2d8d32f86344514359">&#9670;&#160;</a></span>Start()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Timer::Start </td>
          <td>(</td>
          <td class="paramtype">TickType_t&#160;</td>
          <td class="paramname"><em>CmdTimeout</em> = <code>portMAX_DELAY</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p >Start a timer. This changes the state to active.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">CmdTimeout</td><td>How long to wait to send this command to the timer code. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if this command will be sent to the timer code, false if it will not (i.e. timeout). </dd></dl>

</div>
</div>
<a id="ae512d19700e4197dfb6b6e7c59fa6143" name="ae512d19700e4197dfb6b6e7c59fa6143"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae512d19700e4197dfb6b6e7c59fa6143">&#9670;&#160;</a></span>StartFromISR()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Timer::StartFromISR </td>
          <td>(</td>
          <td class="paramtype">BaseType_t *&#160;</td>
          <td class="paramname"><em>pxHigherPriorityTaskWoken</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p >Start a timer from ISR context. This changes the state to active.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pxHigherPriorityTaskWoken</td><td>Did this operation result in a rescheduling event. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if this command will be sent to the timer code, false if it will not (i.e. timeout). </dd></dl>

</div>
</div>
<a id="a15873ed66f31b28e7c7af88ca0c9d2d5" name="a15873ed66f31b28e7c7af88ca0c9d2d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15873ed66f31b28e7c7af88ca0c9d2d5">&#9670;&#160;</a></span>Stop()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Timer::Stop </td>
          <td>(</td>
          <td class="paramtype">TickType_t&#160;</td>
          <td class="paramname"><em>CmdTimeout</em> = <code>portMAX_DELAY</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p >Stop a timer. This changes the state to inactive.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">CmdTimeout</td><td>How long to wait to send this command to the timer code. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if this command will be sent to the timer code, false if it will not (i.e. timeout). </dd></dl>

</div>
</div>
<a id="a403285c6e10f401cd3d9fb43843092cb" name="a403285c6e10f401cd3d9fb43843092cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a403285c6e10f401cd3d9fb43843092cb">&#9670;&#160;</a></span>StopFromISR()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Timer::StopFromISR </td>
          <td>(</td>
          <td class="paramtype">BaseType_t *&#160;</td>
          <td class="paramname"><em>pxHigherPriorityTaskWoken</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p >Stop a timer from ISR context. This changes the state to inactive.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pxHigherPriorityTaskWoken</td><td>Did this operation result in a rescheduling event. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if this command will be sent to the timer code, false if it will not (i.e. timeout). </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/<a class="el" href="timer_8hpp_source.html">timer.hpp</a></li>
<li>src/freertos-addon/c++/ctimer.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
</small></address>
</body>
</html>
